Applying pending or rolling back Gateway updates

Applying pending updates for Runtime Release or rolling back to the previously released version is done on the Gateway Version tab of the API Gateway.

After the Runtime Release period and until the start of the platform release, you can manually apply pending API Gateway updates at any time. The Runtime Release allows you to select a time within that window that is convenient for you to apply pending features and fixes. Pending updates apply per API Gateway. If you apply the pending updates during the Runtime Release window and then change your mind, you can remove the updates and roll back to the currently released version.

Prerequisites

• An API Gateway with a pending Runtime Release update, or a previously applied update that you want to roll back.

• Authorization to apply pending updates or roll back updates for the Gateway.

• To apply the pending Gateway updates:

  1. Go to Configure Server and click the Gateways tab.

  2. Click a Gateway Name from the list.

  3. On the Gateway settings page that opens, click the Gateway Version panel under Deployment.

     If a newer version of the Gateway is available, the version number appears in the Pending Version column. If you have authorization to apply the updates, the Apply Pending Updates button appears at the bottom of the list.

  4. Click Apply Pending Updates.

  5. Click OK in the confirmation dialog that opens.

  6. Click OK in the information dialog about the update process.

     Your Gateway updates shortly. The amount of time that it takes varies based on the activity on the Gateway. The table shows the latest version numbers and last update date. The pending version numbers and Apply Pending Updates button disappear.

• To remove the updates and go back to the currently released version if you applied a pending version of the Gateway during the Runtime Release period:

  1. Go to Configure Server > Authentication and click the Gateways tab.

  2. Click a Gateway Name from the list.

  3. On the Gateway settings page that opens, click the Gateway Version panel.

     If you have applied a Runtime Release update and you are using a more recent version than the currently released version, version numbers appear in the Roll Back Updates column. If you have authorization to remove updates, you view the Roll Back Updates button at the bottom of the list.

  4. Click Roll Back Updates.

  5. Click OK in the confirmation dialog that opens.

  6. Click OK in the information dialog about the rollback process that opens.

     After the updates are applied and the page is refreshed, the API Gateway that was rolled back will display a version that matches the previously available version. The Select Rollback Versions button will not be available when any or all rollbacks are applied, regardless of when the Gateway takes the updates.